Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update Pagination #1695

Merged
merged 8 commits into from
Apr 19, 2022
Merged

docs: update Pagination #1695

merged 8 commits into from
Apr 19, 2022

Conversation

joebuono
Copy link
Contributor

@joebuono joebuono commented Apr 14, 2022

Description of changes

Current Pagination docs: https://ui.docs.amplify.aws/components/pagination

Updated Pagination docs (demo):
pagination

The Pagination docs required an overhaul in order to demonstrate its usage as a controlled component. The first few examples are complete, and I've simplified the code for the styling examples.

The most effective way to review this PR would be to run it locally and see if anything in the Pagination docs needs to be changed.

Issue #, if available

#937

Description of how you validated changes

Running the docs locally.

Checklist

  • PR description included
  • yarn test passes
  • Relevant documentation is changed or added (and PR referenced)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@changeset-bot
Copy link

changeset-bot bot commented Apr 14, 2022

⚠️ No Changeset found

Latest commit: e5f842b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@joebuono joebuono requested review from zchenwei and reesscot April 14, 2022 21:44
@joebuono joebuono temporarily deployed to ci April 14, 2022 21:53 Inactive
@joebuono joebuono temporarily deployed to ci April 14, 2022 21:53 Inactive
@joebuono joebuono temporarily deployed to ci April 14, 2022 21:53 Inactive
@joebuono joebuono temporarily deployed to ci April 14, 2022 21:53 Inactive
Copy link
Contributor

@reesscot reesscot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, just had a few suggestions

docs/src/pages/components/pagination/react.mdx Outdated Show resolved Hide resolved
docs/src/pages/components/pagination/react.mdx Outdated Show resolved Hide resolved
docs/src/pages/components/pagination/react.mdx Outdated Show resolved Hide resolved
@joebuono joebuono temporarily deployed to ci April 15, 2022 22:24 Inactive
@joebuono joebuono temporarily deployed to ci April 15, 2022 22:24 Inactive
@joebuono joebuono temporarily deployed to ci April 15, 2022 22:24 Inactive
@joebuono joebuono temporarily deployed to ci April 15, 2022 22:24 Inactive
@joebuono joebuono changed the title Docs update: Pagination docs: update Pagination Apr 18, 2022
@joebuono joebuono temporarily deployed to ci April 18, 2022 16:48 Inactive
@joebuono joebuono temporarily deployed to ci April 18, 2022 16:48 Inactive
@joebuono joebuono temporarily deployed to ci April 18, 2022 16:48 Inactive
Copy link
Contributor

@jacoblogan jacoblogan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

const totalPages = 5;

const handleNextPage = () => {
console.log('handleNextPage');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have the console.logs in this file?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To help show the developer when these events are triggered

components: {
pagination: {
current: {
backgroundColor: { value: 'rebeccapurple' },
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: do we need to use the tokens?

<Example>
<PaginationSiblingCountExample />
<ExampleCode>
```jsx{8} file=./examples/PaginationSiblingCountExample.tsx
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

curious: what does {8} do?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Highlights line 8 in the mdx

@joebuono joebuono temporarily deployed to ci April 19, 2022 17:57 Inactive
@joebuono joebuono temporarily deployed to ci April 19, 2022 17:57 Inactive
@joebuono joebuono temporarily deployed to ci April 19, 2022 17:57 Inactive
@joebuono joebuono temporarily deployed to ci April 19, 2022 18:18 Inactive
@joebuono joebuono temporarily deployed to ci April 19, 2022 18:18 Inactive
@joebuono joebuono temporarily deployed to ci April 19, 2022 18:18 Inactive
@joebuono joebuono temporarily deployed to ci April 19, 2022 18:18 Inactive
@joebuono joebuono merged commit 4607486 into main Apr 19, 2022
@joebuono joebuono deleted the docs-update-pagination branch April 19, 2022 18:38
zchenwei added a commit that referenced this pull request Apr 20, 2022
* Added new React Guide for Authenticated Routes (#1675)

* Began work on new guides for auth

* Added React guide

* Updated guide

* capitilization update

* Addex Example Wrapper

Co-authored-by: Erik Hanchett <ehhanche@amazon.com>

* chore: align typescript version at root devDependencies (#1686)

* Fixed issue with vue examples (#1688)

Co-authored-by: Erik Hanchett <ehhanche@amazon.com>

* chore: use tsup for dev build (#1690)

* feat(Authenticator): accept general JSX children (#1685)

* Allow non-function children in Authenticator

* Create six-bikes-develop.md

* Update six-bikes-develop.md

* Update packages/react/src/components/Authenticator/Router/index.tsx

Co-authored-by: Caleb Pollman <cpollman@amazon.com>

* Update packages/react/src/components/Authenticator/Router/index.tsx

* Use React.ReactNode and consolidate children type

* Reduce nested ternary

* Add fragments around children

* Fix comments

* Update .changeset/six-bikes-develop.md

Co-authored-by: Caleb Pollman <cpollman@amazon.com>

Co-authored-by: Caleb Pollman <cpollman@amazon.com>

* fix: update focus styling for switchField  (#1667)

* fix: update focus styling for switchField

Co-authored-by: Heather Buchel <buchel@amazon.com>

* chore: update required permissions for publish-latest (#1708)

* docs: add section on token definition structure (#1671)

* docs: add section on token definition structure

Co-authored-by: Heather Buchel <buchel@amazon.com>
Co-authored-by: Scott Rees <6165315+reesscot@users.noreply.github.com>

* chore: (docs) update tabs component demo (#1703)

* chore: (docs) update tabs component demo

Co-authored-by: Heather Buchel <buchel@amazon.com>

* fix(docs Authenticator): Update style authenticator (#1707)

* Updated docs for styling for authenticator

* fixed it so only React sees information about provider

Co-authored-by: Erik Hanchett <ehhanche@amazon.com>

* chore: updating docs build to respect yarn.lock (#1714)

* chore: updating docs build to respect yarn.lock

* chore: adding resolution to clear cache

* Update tests.yml (#1715)

* chore: removing dep resolution

Co-authored-by: William Lee <43682783+wlee221@users.noreply.github.com>

* docs: fixing controlled example bug (#1716)

* docs: fixing dark mode example (#1719)

* docs: update Pagination (#1695)

* refactoring main pagination demo

* more pagination examples

* pagination styling examples

* adjust styles

* demonstrate usePagination hook, and include Theme example for styling

* remove extra backticks

* remove empty code section

Co-authored-by: Joe Buono <joebuono@amazon.com>

* chore: update menu demo to new format (#1702)

* fix(docs): Fix anchor tags between pages (#1706)

* Split off tests to `test-main` and `test-prs` (#1697)

* Split off tests to `test-main` and `test-prs`

* Adjust workflow names

* Add comments

* Skip cache for docs

* chore(ui-react): add jest generated coverage directory to .gitignore (#1718)

* chore: Bump maplibre-gl-js-amplify dependency version (#1721)

* Bump maplibre-gl-js-amplify dependency version

* Create patch changeset for version bump

* chore(bump map libre) (#1722)

* Bump maplibre

* Added changeset

* Added yarn lock

Co-authored-by: Erik Hanchett <ehhanche@amazon.com>

* docs: updating Link docs (#1709)

* docs: updating Link docs

* chore: addressing comments

* docs(fix): remove Theme tab from demos (#1723)

* temporarily remove Theme tab from docs demos

* removed nullish coalescing operator

* small typo

Co-authored-by: Joe Buono <joebuono@amazon.com>

* chore(ui-react): type withAuthenticator (#1724)

* chore: fixing workflow not publishing to next tag (#1725)

* chore: fixing workflow not publishing to next tag

* chore: updating workflow

* chore: updating publish-geo

* chore: update view demo to new format (#1710)

* Version Packages (#1693)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* docs: updating placeholder docs (#1705)

* docs: updating placeholder docs

* docs: adding Theme section

* chore: addressing comments

Co-authored-by: Erik Hanchett <icystorm@gmail.com>
Co-authored-by: Erik Hanchett <ehhanche@amazon.com>
Co-authored-by: Scott Rees <6165315+reesscot@users.noreply.github.com>
Co-authored-by: William Lee <43682783+wlee221@users.noreply.github.com>
Co-authored-by: Caleb Pollman <cpollman@amazon.com>
Co-authored-by: Heather Buchel <hbuchel@gmail.com>
Co-authored-by: Heather Buchel <buchel@amazon.com>
Co-authored-by: Joe Buono <joebuono724@gmail.com>
Co-authored-by: Joe Buono <joebuono@amazon.com>
Co-authored-by: Shane Laymance <shane.laymance@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants